// Copyright (c) 2012 The Chromium Authors. All rights reserved.
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.
//
// A client specific QuicSession subclass.

#ifndef NET_TOOLS_QUIC_QUIC_CLIENT_SESSION_H_
#define NET_TOOLS_QUIC_QUIC_CLIENT_SESSION_H_

#include <memory>
#include <string>

#include "base/macros.h"
#include "net/quic/quic_client_session_base.h"
#include "net/quic/quic_crypto_client_stream.h"
#include "net/quic/quic_protocol.h"
#include "net/tools/quic/quic_spdy_client_stream.h"

namespace net {

class QuicConnection;
class QuicServerId;
class ReliableQuicStream;

class QuicClientSession : public QuicClientSessionBase {
public:
    // Caller retains ownership of |promised_by_url|.
    QuicClientSession(const QuicConfig& config,
        QuicConnection* connection,
        const QuicServerId& server_id,
        QuicCryptoClientConfig* crypto_config,
        QuicClientPushPromiseIndex* push_promise_index);
    ~QuicClientSession() override;
    // Set up the QuicClientSession. Must be called prior to use.
    void Initialize() override;

    // QuicSession methods:
    QuicSpdyClientStream* CreateOutgoingDynamicStream(
        SpdyPriority priority) override;
    QuicCryptoClientStreamBase* GetCryptoStream() override;

    bool IsAuthorized(const std::string& authority) override;

    // QuicClientSessionBase methods:
    void OnProofValid(const QuicCryptoClientConfig::CachedState& cached) override;
    void OnProofVerifyDetailsAvailable(
        const ProofVerifyDetails& verify_details) override;

    // Performs a crypto handshake with the server.
    void CryptoConnect();

    // Returns the number of client hello messages that have been sent on the
    // crypto stream. If the handshake has completed then this is one greater
    // than the number of round-trips needed for the handshake.
    int GetNumSentClientHellos() const;

    int GetNumReceivedServerConfigUpdates() const;

    void set_respect_goaway(bool respect_goaway)
    {
        respect_goaway_ = respect_goaway;
    }

protected:
    // QuicSession methods:
    QuicSpdyStream* CreateIncomingDynamicStream(QuicStreamId id) override;
    // If an outgoing stream can be created, return true.
    bool ShouldCreateOutgoingDynamicStream() override;

    // If an incoming stream can be created, return true.
    bool ShouldCreateIncomingDynamicStream(QuicStreamId id) override;

    // Create the crypto stream. Called by Initialize()
    virtual QuicCryptoClientStreamBase* CreateQuicCryptoStream();

    // Unlike CreateOutgoingDynamicStream, which applies a bunch of sanity checks,
    // this simply returns a new QuicSpdyClientStream. This may be used by
    // subclasses which want to use a subclass of QuicSpdyClientStream for streams
    // but wish to use the sanity checks in CreateOutgoingDynamicStream.
    virtual QuicSpdyClientStream* CreateClientStream();

    const QuicServerId& server_id() { return server_id_; }
    QuicCryptoClientConfig* crypto_config() { return crypto_config_; }

private:
    std::unique_ptr<QuicCryptoClientStreamBase> crypto_stream_;
    QuicServerId server_id_;
    QuicCryptoClientConfig* crypto_config_;

    // If this is set to false, the client will ignore server GOAWAYs and allow
    // the creation of streams regardless of the high chance they will fail.
    bool respect_goaway_;

    DISALLOW_COPY_AND_ASSIGN(QuicClientSession);
};

} // namespace net

#endif // NET_TOOLS_QUIC_QUIC_CLIENT_SESSION_H_
